docs: detailing in docstrings the scope and context of each serialisation function - #11899
Closed
davidsbatista wants to merge 1 commit into
Closed
docs: detailing in docstrings the scope and context of each serialisation function#11899davidsbatista wants to merge 1 commit into
davidsbatista wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
Contributor
Coverage reportClick to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issues
Proposed Changes:
Docstring-only additions, no behavior change. Added short "why" notes to 5 functions that looked like they could be merged or simplified, but can't:
default_to_dict/default_from_dict(core/serialization.py) — notes this is the on-disk pipeline YAML format, incompatible withbase_serialization's._serialize_value_with_schema(utils/base_serialization.py) — notes it's for runtime values, not Components, and points back to the note above._serializable_value(tracing/utils.py) — notes it's deliberately one-way/lossy, unlike the schema serializer._serialize_content_part(dataclasses/chat_message.py) — notes the short tags are a deliberate hand-writable public format._serialize_object(components/generators/utils.py) — notes it skips private attributes for OpenAI SDK objects, unlike the generic serializer.These came out of an investigation into duplicated/scattered serialization code (see related PRs). Most of what looked like duplication turned out to be intentional separation — these notes capture the reasoning directly in the code so it doesn't get
"helpfully" merged later.
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.